<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: TunecoreDirect::Response</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">TunecoreDirect::Response</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../files/lib/tunecore_direct/response_rb.html">
                lib/tunecore_direct/response.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                TunecoreDirect::Base
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
Represents a response from the TC web service. This class is designed to
take a response from any method call in the API and create a SDK <a
href="Response.html#M000016">object</a> out of it. It will look at the root
XML node in the body of the HTTP response to determine the type of <a
href="Response.html#M000016">object</a> to return.
</p>
<p>
When a response comes back from the TuneCore web service it is processed
with this class. The <a href="Response.html#M000016">object</a> being
returned is extracted with the <a
href="Response.html#M000016">Response#object</a> method. You
shouldn&#8216;t have to use this class directly, as convenience methods are
provided in the Person, <a href="Album.html">Album</a>, and <a
href="Song.html">Song</a> classes.
</p>
<p>
Any API <a href="Response.html#M000016">object</a> errors will be set in
the errors accessor and the <a href="Response.html#M000016">object</a> type
will be set in the type accessor.
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000015">new</a>&nbsp;&nbsp;
      <a href="#M000016">object</a>&nbsp;&nbsp;
      <a href="#M000017">to_xml</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->
    <div id="includes">
      <h3 class="section-bar">Included Modules</h3>

      <div id="includes-list">
        <span class="include-name">TunecoreDirect</span>
      </div>
    </div>

    <div id="section">





    <div id="attribute-list">
      <h3 class="section-bar">Attributes</h3>

      <div class="name-list">
        <table>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">errors</td>
          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">status</td>
          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">type</td>
          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        </table>
      </div>
    </div>
      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000015" class="method-detail">
        <a name="M000015"></a>

        <div class="method-heading">
          <a href="Response.src/M000015.html" target="Code" class="method-signature"
            onclick="popupCode('Response.src/M000015.html');return false;">
          <span class="method-name">new</span><span class="method-args">( body )</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Accepts the body of the HTTP response from the TC web service.
</p>
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000016" class="method-detail">
        <a name="M000016"></a>

        <div class="method-heading">
          <a href="Response.src/M000016.html" target="Code" class="method-signature"
            onclick="popupCode('Response.src/M000016.html');return false;">
          <span class="method-name">object</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns the appropriate <a href="Response.html#M000016">object</a> based on
the complete response XML we got from the web service. The <a
href="Response.html#M000016">object</a> returned will be one of the
following, based on what type of request you made:
</p>
<ul>
<li>Person

</li>
<li><a href="Album.html">Album</a>

</li>
<li><a href="Song.html">Song</a>

</li>
<li>Array of people

</li>
<li>Array of albums

</li>
<li>Array of songs

</li>
</ul>
        </div>
      </div>

      <div id="method-M000017" class="method-detail">
        <a name="M000017"></a>

        <div class="method-heading">
          <a href="Response.src/M000017.html" target="Code" class="method-signature"
            onclick="popupCode('Response.src/M000017.html');return false;">
          <span class="method-name">to_xml</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>